<?xml version="1.0" encoding="utf-8" ?>
<CodeDoc>
	<Class name="DockPane">
		<Enum name="AppearanceStyle">
			<EnumDef>
				<summary>Specifies the appearance style of <see cref="DockPane"/>.</summary>
			</EnumDef>
			<Member name="ToolWindow">
				<summary>Tool window style <see cref="DockPane"/>.</summary>
			</Member>
			<Member name="Document">
				<summary>Document style <see cref="DockPane"/>.</summary>
			</Member>
		</Enum>
		<ClassDef>
			<summary>The containing window for a collection of <see cref="Wrath.Windows.Forms.IDockContent" /> forms
			displayed in a tabbed manner.</summary>
			<remarks>
				<include file='DockPane.xml' path='//CodeDoc/Class[@name="DockPane"]/Property[@name="Contents"]/remarks/*' />
				<para>
				There are two types of <see cref="Wrath.Windows.Forms.DockPane" /> in appearance:
				<see cref="AppearanceStyle.ToolWindow" /> and <see cref="AppearanceStyle.Document" />, 
				determined by the docking state of the <see cref="Wrath.Windows.Forms.DockPane" />.
				</para>
				<para>
				You can derive your own class from <see cref="Wrath.Windows.Forms.DockPane" /> to make
				your own customizations. If so, you need to override the <see cref="Wrath.Windows.Forms.DockPanel.DockPaneFactory" />
				property to return the instance of your own class.
				</para>
			</remarks>
		</ClassDef>
		<Constructor name="Overloads">
			<overloads>
				<summary>Initializes a new instance of DockPane class.</summary>
			</overloads>
		</Constructor>
		<Constructor name="(IDockContent, DockState, bool)">
			<summary>Initializes a new instance of DockPane class, with specified visible docking state.</summary>
			<param name="content">The first IDockContent for this DockPane.</param>
			<param name="visibleState">The visible docking state for this DockPane.</param>
			<param name="show"><b>True</b> to show the <paramref name="content" />, otherwise, <b>false</b>.</param>
		</Constructor>
		<Constructor name="(IDockContent, FloatWindow, bool)">
			<summary>Initializes a new instance of DockPane class, as nested docking to specified FloatWindow.</summary>
			<param name="content">The first IDockContent for this DockPane.</param>
			<param name="floatWindow">The <see cref="Wrath.Windows.Forms.FloatWindow"/> for nested docking.</param>
			<param name="show"><b>True</b> to show the <paramref name="content" />, otherwise, <b>false</b>.</param>
		</Constructor>
		<Constructor name="(IDockContent, DockPane, DockAlignment, double, bool)">
			<summary>Initializes a new instance of DockPane class, as specified nested docking.</summary>
			<include file='DockPane.xml' path='//CodeDoc/Class[@name="DockPane"]/Constructor[@name="(IDockContent, DockState, bool)"]/param[@name="content"]' />
			<param name="prevPane">The target <see cref="Wrath.Windows.Forms.DockPane" /> to dock.</param>
			<param name="alignment">The edge of the target <see cref="Wrath.Windows.Forms.DockPane" /> to dock.</param>
			<param name="proportion">The proportion size of the source <see cref="Wrath.Windows.Forms.DockPane" />
			to take inside the target <see cref="Wrath.Windows.Forms.DockPane" />.</param>
			<include file='DockPane.xml' path='//CodeDoc/Class[@name="DockPane"]/Constructor[@name="(IDockContent, DockState, bool)"]/param[@name="show"]' />
		</Constructor>
		<Constructor name="(IDockContent, Rectangle, bool)">
			<summary>Initializes a new instance of DockPane class, as floating at the specified bounds.</summary>
			<include file='DockPane.xml' path='//CodeDoc/Class[@name="DockPane"]/Constructor[@name="(IDockContent, DockState, bool)"]/param[@name="content"]' />
			<param name="floatWindowBounds">The bounds of the floating window.</param>
			<include file='DockPane.xml' path='//CodeDoc/Class[@name="DockPane"]/Constructor[@name="(IDockContent, DockState, bool)"]/param[@name="show"]' />
		</Constructor>
		<Property name="ActiveContent">
			<summary>Gets or sets the currently active <see cref="Wrath.Windows.Forms.IDockContent" /> form.</summary>
			<value>The currently active <see cref="Wrath.Windows.Forms.IDockContent" /> form.</value>
		</Property>
		<Property name="AllowRedocking">
			<summary>Gets or sets to specify whether drag and drop re-docking is allowed.</summary>
			<value><b>True</b> if drag and drop re-docking is allowed, otherwise, <b>false</b>.</value>
		</Property>
		<Property name="Appearance">
			<summary>Gets the <see cref="AppearanceStyle"/> of the <see cref="DockPane"/>.</summary>
			<value>The <see cref="AppearanceStyle"/> of the <see cref="DockPane"/>.</value>
		</Property>
		<Property name="CaptionText">
			<summary>Gets the text displayed for the caption.</summary>
			<value>The text displayed for the caption.</value>
			<remarks>The default implementation returns the <see cref="System.Windows.Forms.Control.Text" /> property
			of current active <see cref="Wrath.Windows.Forms.IDockContent" /> form. You can override this
			property to provide your own implementation.</remarks>
		</Property>
		<Property name="Contents">
			<summary>Gets the collection of contained <see cref="Wrath.Windows.Forms.IDockContent" /> forms.</summary>
			<value>The <see cref="Wrath.Windows.Forms.DockContentCollection" /> which contains all the
			<see cref="Wrath.Windows.Forms.IDockContent" /> forms for this <see cref="Wrath.Windows.Forms.DockPane" />.</value>
			<remarks>
				<para>
				A <see cref="Wrath.Windows.Forms.IDockContent" /> object can be added to the
				<see cref="Wrath.Windows.Forms.DockPane" /> by various of ways:
				<list type="number">
						<item>
							<description>Calling one of <see cref="Wrath.Windows.Forms.DockPane" /> class's constructors,
					providing the <see cref="Wrath.Windows.Forms.IDockContent" /> object as parameter.
					</description>
						</item>
						<item>
							<description>Explicitly setting one of the
					<see cref="Wrath.Windows.Forms.DockContentHandler.Pane" />,
					<see cref="Wrath.Windows.Forms.DockContentHandler.PanelPane" /> or
					<see cref="Wrath.Windows.Forms.DockContentHandler.FloatPane" /> properties
					of <see cref="Wrath.Windows.Forms.IDockContent.DockHandler" /> class.
					</description>
						</item>
						<item>
							<description>Implicitly setting the docking state of the <see cref="Wrath.Windows.Forms.IDockContent" />,
					for example, calling one of the <see cref="Wrath.Windows.Forms.DockContentHandler.Show" /> methods.
					</description>
						</item>
					</list>
					You can access the contained collection of
					<see cref="Wrath.Windows.Forms.IDockContent" /> forms through the
					<see cref="Wrath.Windows.Forms.DockPane.Contents" /> property of class
					<see cref="Wrath.Windows.Forms.DockPane" />, and you can access a
					<see cref="Wrath.Windows.Forms.IDockContent" />'s containing
					<see cref="Wrath.Windows.Forms.DockPane" /> through its <see cref="Wrath.Windows.Forms.DockContentHandler" />'s
					<see cref="Wrath.Windows.Forms.DockContentHandler.Pane" />,
					<see cref="Wrath.Windows.Forms.DockContentHandler.PanelPane" /> or
					<see cref="Wrath.Windows.Forms.DockContentHandler.FloatPane" /> properties.					
				</para>
				<para>If there is no <see cref="Wrath.Windows.Forms.IDockContent" /> in
				this <see cref="Wrath.Windows.Forms.DockPane" />,
				this <see cref="Wrath.Windows.Forms.DockPane" /> will be disposed automatically.
				</para>
			</remarks>
		</Property>
		<Property name="DisplayingContents">
			<summary>Gets the collection of displaying <see cref="IDockContent" /> forms.</summary>
			<value>The <see cref="DockContentCollection" /> which contains all the displaying
			<see cref="IDockContent" /> forms for this <see cref="DockPane" />.</value>
			<seealso cref="DockPane.Contents"/>
		</Property>
		<Property name="DockListContainer">
			<summary>Gets the <see cref="Wrath.Windows.Forms.IDockListContainer" /> which contains this
			<see cref="Wrath.Windows.Forms.DockPane" />.</summary>
			<value>The <see cref="Wrath.Windows.Forms.IDockListContainer" /> which contains this
			<see cref="Wrath.Windows.Forms.DockPane" />.</value>
			<include file='DockPane.xml' path='//CodeDoc/Class[@name="DockPane"]/Property[@name="IsFloat"]/remarks' />
		</Property>
		<Property name="DockPanel">
			<summary>Gets the <see cref="Wrath.Windows.Forms.DockPanel" /> associated with this
			<see cref="Wrath.Windows.Forms.DockPane" />.</summary>
			<value>the <see cref="Wrath.Windows.Forms.DockPanel" /> associated with this
			<see cref="Wrath.Windows.Forms.DockPane" />.</value>
		</Property>
		<Property name="DockState">
			<summary>Gets the docking state of this <see cref="Wrath.Windows.Forms.DockPane" />.</summary>
			<value>The docking state of this <see cref="Wrath.Windows.Forms.DockPane" />.</value>
		</Property>
		<Property name="DockWindow">
			<summary>Gets or sets the <see cref="Wrath.Windows.Forms.DockWindow" /> contains this
			<see cref="Wrath.Windows.Forms.DockPane" />.</summary>
			<value>Gets or sets the <see cref="Wrath.Windows.Forms.DockWindow" /> contains this
			<see cref="Wrath.Windows.Forms.DockPane" />.</value>
			<include file='DockPane.xml' path='//CodeDoc/Class[@name="DockPane"]/Property[@name="IsFloat"]/remarks' />
		</Property>
		<Property name="FloatWindow">
			<summary>Gets or sets the <see cref="Wrath.Windows.Forms.FloatWindow" /> contains this
			<see cref="Wrath.Windows.Forms.DockPane" />.</summary>
			<value>Gets or sets the <see cref="Wrath.Windows.Forms.FloatWindow" /> contains this
			<see cref="Wrath.Windows.Forms.DockPane" />.</value>
			<include file='DockPane.xml' path='//CodeDoc/Class[@name="DockPane"]/Property[@name="IsFloat"]/remarks' />
		</Property>
		<Property name="IsActivated">
			<summary>Gets whether this <see cref="Wrath.Windows.Forms.DockPane" /> is activated.</summary>
			<value><b>True</b> if this <see cref="Wrath.Windows.Forms.DockPane" /> is activated,
			otherwise, <b>false</b>.</value>
		</Property>
		<Property name="IsActiveDocumentPane">
			<summary>Gets whether this <see cref="Wrath.Windows.Forms.DockPane" /> is active document pane.</summary>
			<value><b>True</b> if this <see cref="Wrath.Windows.Forms.DockPane" /> is active document pan,
			otherwise, <b>false</b>.</value>
		</Property>
		<Property name="IsAutoHide">
			<summary>Gets whether the docking state is auto hide.</summary>
			<value><b>True</b> if the docking state is auto hide,
			otherwise, <b>false</b>.</value>
		</Property>
		<Property name="IsFloat">
			<summary>Gets whether this <see cref="Wrath.Windows.Forms.DockPane" /> is floating.</summary>
			<value><b>True</b> if this <see cref="Wrath.Windows.Forms.DockPane" /> is floating,
			otherwise, <b>false</b>.</value>
			<remarks>
			The <see cref="Wrath.Windows.Forms.DockPane.IsFloat" /> property is fixed during the construction
			<see cref="Wrath.Windows.Forms.DockPane" /> class, based on the initial docking state. If this
			property returns <b>true</b>, it can only be contained by a <see cref="Wrath.Windows.Forms.FloatWindow" />
			as its <see cref="Wrath.Windows.Forms.DockPane.DockListContainer" />; otherwise it can only be contained
			by a <see cref="Wrath.Windows.Forms.DockWindow" /> as its
			<see cref="Wrath.Windows.Forms.DockPane.DockListContainer" />.
			</remarks>
		</Property>
		<Property name="IsHidden">
			<summary>Gets whether all the contained <see cref="Wrath.Windows.Forms.IDockContent" /> forms
			are invisible in this <see cref="Wrath.Windows.Forms.DockPane" />.</summary>
			<value><b>True</b> if all the contained <see cref="Wrath.Windows.Forms.IDockContent" /> forms
			are invisible in this <see cref="Wrath.Windows.Forms.DockPane" />.</value>
		</Property>
		<Property name="NestedDockingStatus">
			<summary>Gets the nested docking status for this <see cref="Wrath.Windows.Forms.NestedDockingStatus" />.</summary>
			<value>A <see cref="Wrath.Windows.Forms.NestedDockingStatus" /> object to represent
			the nested docking status for this <see cref="Wrath.Windows.Forms.DockPane" />.</value>
		</Property>
		<Method name="Activate()">
			<summary>Activates the DockPane and gives it focus.</summary>
		</Method>
		<Method name="AddToDockList">
			<overloads>
				<summary>Nested docks this <see cref="Wrath.Windows.Forms.DockPane" /> to the specified
				<see cref="Wrath.Windows.Forms.IDockListContainer" />.</summary>
			</overloads>
		</Method>
		<Method name="AddToDockList(IDockListContainer)">
			<summary>Nested docks this <see cref="Wrath.Windows.Forms.DockPane" /> to the specified
			<see cref="Wrath.Windows.Forms.IDockListContainer" />, with default settings.</summary>
			<param name="container">The <see cref="Wrath.Windows.Forms.IDockListContainer" /> for the
			nested docking.</param>
			<returns>If the <see cref="Wrath.Windows.Forms.DockPane.IsFloat" /> property conforms to
			the container's docking state, the current <see cref="Wrath.Windows.Forms.DockPane" /> object
			will be returned; otherwise, a new instance of <see cref="Wrath.Windows.Forms.DockPane" />
			object will be created and returned.</returns>
		</Method>
		<Method name="AddToDockList(IDockListContainer, DockPane, DockAlignment, double)">
			<summary>Nested docks this <see cref="Wrath.Windows.Forms.DockPane" /> to the specified
			<see cref="Wrath.Windows.Forms.IDockListContainer" />, with specified settings.</summary>
			<include file='DockPane.xml' path='//CodeDoc/Class[@name="DockPane"]/Method[@name="AddToDockList(IDockListContainer)"]/param[@name="container"]' />
			<param name="prevPane"></param>
			<param name="alignment"></param>
			<param name="proportion"></param>
			<include file='DockPane.xml' path='//CodeDoc/Class[@name="DockPane"]/Method[@name="AddToDockList(IDockListContainer)"]/returns' />
		</Method>
		<Method name="CloseActiveContent()">
			<summary>Closes the currently active <see cref="IDockContent"/>.</summary>
		</Method>
		<Method name="Float()">
			<summary>Shows all contained <see cref="Wrath.Windows.Forms.IDockContent" /> forms as floating.</summary>
			<returns>The new floating <see cref="Wrath.Windows.Forms.DockPane" /> for the
			<see cref="Wrath.Windows.Forms.IDockContent" /> forms.</returns>
		</Method>
		<Method name="IsDockStateValid(DockState)">
			<summary>Tests if the giving docking state conforms to the
			<see cref="Wrath.Windows.Forms.DockContentHandler.DockableAreas" /> property of all the
			contained <see cref="Wrath.Windows.Forms.IDockContent" /> forms.</summary>
			<param name="dockState"></param>
			<returns><b>True</b> if the giving docking state conforms to the
			<see cref="Wrath.Windows.Forms.DockContentHandler.DockableAreas" /> property of all the
			contained <see cref="Wrath.Windows.Forms.IDockContent" /> forms; otherwise, <b>false</b>.</returns>
		</Method>
		<Method name="OnDockStateChanged(EventArgs)">
			<summary>Raises the <see cref="Wrath.Windows.Forms.DockPane.DockStateChanged" /> event.</summary>
			<param name="e">An <see cref="System.EventArgs" /> that contains the event data.</param>
		</Method>
		<Method name="OnIsActivatedChanged(EventArgs)">
			<summary>Raises the <see cref="Wrath.Windows.Forms.DockPane.IsActivatedChanged" /> event.</summary>
			<param name="e">An <see cref="System.EventArgs" /> that contains the event data.</param>
		</Method>
		<Method name="OnIsActiveDocumentPaneChanged(EventArgs)">
			<summary>Raises the <see cref="Wrath.Windows.Forms.DockPane.IsActiveDocumentPaneChanged" /> event.</summary>
			<param name="e">An <see cref="System.EventArgs" /> that contains the event data.</param>
		</Method>
		<Method name="RestoreToPanel()">
			<summary>Shows all contained <see cref="Wrath.Windows.Forms.IDockContent" /> forms as non-floating.</summary>
		</Method>
		<Method name="SetContentIndex(IDockContent, int)">
			<summary>Moves the specified <see cref="Wrath.Windows.Forms.IDockContent" /> form to the
			specified position in the tab strip.</summary>
			<param name="content">The specified <see cref="Wrath.Windows.Forms.IDockContent" /> form.</param>
			<param name="index">The zero-based index represents the new position in the tab strip.</param>
		</Method>
		<Method name="SetDockState(DockState)">
			<summary>Shows all contained <see cref="Wrath.Windows.Forms.IDockContent" /> forms as specified docking state.</summary>
			<param name="value">The specified docking state to display.</param>
			<returns>The <see cref="Wrath.Windows.Forms.DockPane" /> for the new docking state.</returns>
		</Method>
		<Method name="SetNestedDockingProportion(double)">
			<summary>Sets the proportion size of this DockPane for nested docking.</summary>
			<param name="proportion">The proportion size to set. Value must between 0 and 1.</param>
		</Method>
		<Event name="DockStateChanged">
			<summary>Occurs when the <see cref="Wrath.Windows.Forms.DockPane.DockState"/> property changed.</summary>
		</Event>
		<Event name="IsActivatedChanged">
			<summary>Occurs when the <see cref="Wrath.Windows.Forms.DockPane.IsActivated"/> property changed.</summary>
		</Event>
		<Event name="IsActiveDocumentPaneChanged">
			<summary>Occurs when the <see cref="Wrath.Windows.Forms.DockPane.IsActiveDocumentPane"/> property changed.</summary>
		</Event>
	</Class>
</CodeDoc>
